<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_hdmirxss: xhdmi_menu.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hdmirxss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xhdmi__menu_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xhdmi_menu.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for the Xilinx Menu implementation as used in the HDMI example design. </p>
<p><b>Software Initialization &amp; Configuration</b></p>
<p><b>Interrupts </b></p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b> Asserts </b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b> Building the driver </b></p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date       Changes
<hr/>

X.X   ..   DD-MM-YYYY ..
1.0   RHe  10-07-2015 Initial version
1.1   MG   03-02-2016 Added HDCP support
1.1   YH   27-07-2016 Remove Separate HDCP menu, keep only HDCP Main Menu
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hdmi___menu_config.html">XHdmi_MenuConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI menu configuration.  <a href="struct_x_hdmi___menu_config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI menu instance data.  <a href="struct_x_hdmi___menu.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a896c61616bb6eadcdfe1b51f08ae7d66"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a896c61616bb6eadcdfe1b51f08ae7d66">XHDMI_MENU_H_</a></td></tr>
<tr class="memdesc:a896c61616bb6eadcdfe1b51f08ae7d66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a896c61616bb6eadcdfe1b51f08ae7d66">More...</a><br /></td></tr>
<tr class="separator:a896c61616bb6eadcdfe1b51f08ae7d66"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8425d7c3a20915745a94c5b552376d4a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a8425d7c3a20915745a94c5b552376d4a">XHdmi_MenuType</a> <tr class="memdesc:a8425d7c3a20915745a94c5b552376d4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI menu types.  <a href="xhdmi__menu_8h.html#a8425d7c3a20915745a94c5b552376d4a">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a8425d7c3a20915745a94c5b552376d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab58fedfa2d83d72245cd759ff53c2c3b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#ab58fedfa2d83d72245cd759ff53c2c3b">XHdmi_MenuInitialize</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr, u32 UartBaseAddress)</td></tr>
<tr class="memdesc:ab58fedfa2d83d72245cd759ff53c2c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function takes care of the HDMI menu initialization.  <a href="#ab58fedfa2d83d72245cd759ff53c2c3b">More...</a><br /></td></tr>
<tr class="separator:ab58fedfa2d83d72245cd759ff53c2c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d5275f81a5e4353687df46fd1bedb88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a6d5275f81a5e4353687df46fd1bedb88">XHdmi_MenuProcess</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a6d5275f81a5e4353687df46fd1bedb88"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to trigger the HDMI menu statemachine.  <a href="#a6d5275f81a5e4353687df46fd1bedb88">More...</a><br /></td></tr>
<tr class="separator:a6d5275f81a5e4353687df46fd1bedb88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8507711886833ab068231566550c677e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a8507711886833ab068231566550c677e">XHdmi_MenuReset</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a8507711886833ab068231566550c677e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the menu to the main menu.  <a href="#a8507711886833ab068231566550c677e">More...</a><br /></td></tr>
<tr class="separator:a8507711886833ab068231566550c677e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a896c61616bb6eadcdfe1b51f08ae7d66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a896c61616bb6eadcdfe1b51f08ae7d66">&#9670;&nbsp;</a></span>XHDMI_MENU_H_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XHDMI_MENU_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a8425d7c3a20915745a94c5b552376d4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8425d7c3a20915745a94c5b552376d4a">&#9670;&nbsp;</a></span>XHdmi_MenuType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xhdmi__menu_8h.html#a8425d7c3a20915745a94c5b552376d4a">XHdmi_MenuType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The HDMI menu types. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab58fedfa2d83d72245cd759ff53c2c3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab58fedfa2d83d72245cd759ff53c2c3b">&#9670;&nbsp;</a></span>XHdmi_MenuInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>UartBaseAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function takes care of the HDMI menu initialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>.</p>

</div>
</div>
<a id="a6d5275f81a5e4353687df46fd1bedb88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d5275f81a5e4353687df46fd1bedb88">&#9670;&nbsp;</a></span>XHdmi_MenuProcess()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to trigger the HDMI menu statemachine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
    <tr><td class="paramname">input</td><td>is the value used for the next menu state decoder.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="a8507711886833ab068231566550c677e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8507711886833ab068231566550c677e">&#9670;&nbsp;</a></span>XHdmi_MenuReset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets the menu to the main menu. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
